Zync SDK/zync.api.company.models

Package-level declarations

Types

GetCompanyConfigResult

sealed class GetCompanyConfigResult

Result type for getting company configuration.

GetCompanyModuleResult

sealed class GetCompanyModuleResult

Result type for getting a single company module.

GetCompanyModulesResult

sealed class GetCompanyModulesResult

Result type for getting company modules.

GetCompanyPolicyResult

sealed class GetCompanyPolicyResult

Result type for getting company policy.

GetCompanyResult

sealed class GetCompanyResult

Result type for getting company details.

ZyncCompany

data class ZyncCompany(val companyUid: String, val companyName: String, val companyLogo: String?, val companyLoginName: String, val companyCurrency: String?, val companyCountryCode: String?, val companyAddress: String?, val companyTimezone: String?, val createdAt: String?, val updatedAt: String?, val syncedAt: String?)

Domain model representing a Company (workspace) in Zuper. This represents the business workspace that users belong to.

ZyncCompanyAttachmentsPolicy

data class ZyncCompanyAttachmentsPolicy(val compressImage: Boolean, val maxAttachmentSize: Int, val maxNoOfAttachments: Int)

ZyncCompanyBusinessHours

data class ZyncCompanyBusinessHours(val timezone: String?, val startTime: String?, val endTime: String?, val workingDays: List<String>?)

ZyncCompanyCommunicationConfig

data class ZyncCompanyCommunicationConfig(val enableSms: Boolean, val enableEmail: Boolean)

ZyncCompanyConfig

data class ZyncCompanyConfig(val businessHours: ZyncCompanyBusinessHours?, val general: ZyncCompanyGeneralConfig?, val customers: ZyncCompanyCustomerConfig?, val jobs: ZyncCompanyJobConfig?, val timesheet: ZyncCompanyTimesheetConfig?, val quote: ZyncCompanyQuoteConfig?, val invoice: ZyncCompanyInvoiceConfig?, val financing: ZyncCompanyFinanceConfig?, val tax: ZyncCompanyTaxConfig?, val taxation: ZyncCompanyTaxationConfig?, val product: ZyncCompanyProductConfig?, val contract: ZyncCompanyContractConfig?, val metaInfo: ZyncCompanyMetaInfo?, val project: ZyncCompanyProjectConfig?, val communication: ZyncCompanyCommunicationConfig?, val employee: ZyncCompanyEmployeeConfig?)

Domain model for Company Configuration. Contains business settings and operational configurations.

ZyncCompanyContractConfig

data class ZyncCompanyContractConfig(val enableContracts: Boolean)

ZyncCompanyCustomerConfig

data class ZyncCompanyCustomerConfig(val autoAssignCustomerNumber: Boolean)

ZyncCompanyEmployeeConfig

data class ZyncCompanyEmployeeConfig(val enableEmployeeManagement: Boolean)

ZyncCompanyFinanceConfig

data class ZyncCompanyFinanceConfig(val enableFinancing: Boolean)

ZyncCompanyGeneralConfig

data class ZyncCompanyGeneralConfig(val defaultCurrency: String?, val dateFormat: String?, val timeFormat: String?)

ZyncCompanyInvoiceConfig

data class ZyncCompanyInvoiceConfig(val autoAssignInvoiceNumber: Boolean)

ZyncCompanyJobConfig

data class ZyncCompanyJobConfig(val autoAssignJobNumber: Boolean, val allowJobEditAfterCompletion: Boolean)

ZyncCompanyMetaInfo

data class ZyncCompanyMetaInfo(val companyWebsite: String?, val companyPhone: String?)

ZyncCompanyModule

data class ZyncCompanyModule(val companyModuleUid: String, val moduleUid: String, val moduleName: String, val moduleKey: String)

Domain model representing a company module in the Zuper system.

ZyncCompanyPolicy

data class ZyncCompanyPolicy(val ssoEnabled: Boolean, val financingEnabled: Boolean, val proposalEnabled: Boolean, val twoFactorEnabled: Boolean, val offlineEnabled: Boolean, val serviceTaskEnabled: Boolean, val attachmentsPolicy: ZyncCompanyAttachmentsPolicy?, val customerPortalEnabled: Boolean, val priceListEnabled: Boolean, val enableB2B: Boolean, val timeLogV2Enabled: Boolean, val expenseTrackingEnabled: Boolean, val zuperPayPolicy: ZyncCompanyZuperPayPolicy?, val zuperConnectEnabled: Boolean, val zuperAiEnabled: Boolean, val enableV2ServiceTask: Boolean, val powerappsEnabled: Boolean, val realtimeUpdatesEnabled: Boolean)

Domain model for Company Policy. Contains feature flags and security policies.

ZyncCompanyProductConfig

data class ZyncCompanyProductConfig(val enableProductCatalog: Boolean)

ZyncCompanyProjectConfig

data class ZyncCompanyProjectConfig(val enableProjects: Boolean)

ZyncCompanyQuoteConfig

data class ZyncCompanyQuoteConfig(val autoAssignQuoteNumber: Boolean)

ZyncCompanyTaxationConfig

data class ZyncCompanyTaxationConfig(val taxInclusive: Boolean)

ZyncCompanyTaxConfig

data class ZyncCompanyTaxConfig(val defaultTaxRate: Double?)

ZyncCompanyTimesheetConfig

data class ZyncCompanyTimesheetConfig(val enableTimesheet: Boolean, val requirePunchInLocation: Boolean)

ZyncCompanyZuperPayPolicy

data class ZyncCompanyZuperPayPolicy(val isEnabled: Boolean, val isTapToPayEnabled: Boolean)